Package | ihe.iti.mhd |
Type | CapabilityStatement |
Id | Id |
FHIR Version | R4 |
Source | https://profiles.ihe.net/ITI/MHD/https://build.fhir.org/ig/IHE/ITI.MHD/CapabilityStatement-IHE.MHD.DocumentConsumer.html |
Url | https://profiles.ihe.net/ITI/MHD/CapabilityStatement/IHE.MHD.DocumentConsumer |
Version | 4.2.3-current |
Status | active |
Date | 2024-07-15T19:14:36+00:00 |
Name | IHE_MHD_DocumentConsumer |
Title | Document Consumer (client) |
Experimental | False |
Realm | uv |
Authority | ihe |
Description | IHE ITI Mobile access to Health Documents (MHD) - Document Consumer (client). |
Kind | requirements |
CapabilityStatement | |
https://profiles.ihe.net/ITI/mXDE/CapabilityStatement/IHE.mXDE.ClinicalDataConsumer | mXDE Clinical Data Consumer Actor |
https://profiles.ihe.net/ITI/mXDE/CapabilityStatement/IHE.mXDE.DataElementExtractor | mXDE Data Element Extractor Actor |
SearchParameter | |
DocumentReference-Creation | Creation |
List-DesignationType | DesignationType |
List-SourceId | SourceId |
https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.List | MHD common List with designationType |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement IHE.MHD.DocumentConsumer
application/fhir+xml
, application/fhir+json
Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
client
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
DocumentReference | https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Query.Minimal.DocumentReference | y | y | _id, _lastupdated, author.given, author.family, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, related, security-label, setting, status, type | |||||
List | https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.List | y | y | _id, _lastupdated, code, date, identifier, patient, patient.identifier, source.given, source.family, status, designationType, sourceId | |||||
Binary | y |
read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | Logical id of this artifact |
SHALL | _lastupdated | date | When the resource version last changed |
SHALL | author.given | string | These parameters, of type string, specify the name parts of the author person, which is associated with the DocumentReference Resource, or in Document Sharing nomenclature, the author of the Document Entry. See ITI TF-2x: Appendix Z.2 for use of the string data type. |
SHALL | author.family | string | These parameters, of type string, specify the name parts of the author person, which is associated with the DocumentReference Resource, or in Document Sharing nomenclature, the author of the Document Entry. See ITI TF-2x: Appendix Z.2 for use of the string data type. |
SHALL | category | token | Categorization of document |
SHALL | creation | date | When this document was created |
SHALL | date | date | When this document reference was created |
SHALL | event | token | Main clinical acts documented |
SHALL | facility | token | Kind of facility where patient was seen |
SHALL | format | token | Format/content rules for the document |
SHALL | identifier | token | The identifier for this DocumentReference |
SHALL | patient | reference | Who/what is the subject of the document |
SHALL | patient.identifier | token | An Identifier for Who/what is the subject of the document |
SHALL | period | date | Time of service that is being documented |
SHALL | related | reference | Related Resource |
SHALL | security-label | token | Document security-tags |
SHALL | setting | token | Additional details about where the content was created (e.g. clinical specialty) |
SHALL | status | token | current | superseded | entered-in-error |
SHALL | type | reference | Kind of document (LOINC if possible) |
read
, search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | Logical id of this artifact |
SHALL | _lastupdated | date | When the resource version last changed |
SHALL | code | token | This parameter, of type token, specifies the code.coding value supplied in the List Resource. The value of the code element indicates the List of type SubmissionSet or Folder as indicated. |
SHALL | date | date | This parameter, of type date, specifies the time when the List was created. |
SHALL | identifier | token | This parameter, of type token, specifies an identifier for this List. The search results represent the results of a search on List.masterIdentifier and List.identifier. See ITI TF-2x: Appendix Z.2 for additional constraints on the use of the token search parameter type. |
SHALL | patient | reference | This parameter is of type Reference(Patient). The Document Consumer may get this reference through the use of the PDQm or PIXm Profiles, or by some other method. When the patient parameter is used, the Patient reference would need to be accessible to both the Document Consumer and the Document Responder. |
SHALL | patient.identifier | token | An Identifier for Who/what is the subject of the document |
SHALL | source.given | string | These parameters, of type string, specify the name parts of the author person which is associated with the List. See ITI TF-2x: Appendix Z.2 for use of the string data type. |
SHALL | source.family | string | These parameters, of type string, specify the name parts of the author person which is associated with the List. See ITI TF-2x: Appendix Z.2 for use of the string data type. |
SHALL | status | token | This parameter, of type token, specifies the status of the List. If included in the query, the Document Consumer shall populate the code portion of the token with one of the codes in the following Table 3.66.4.1.2.1-1: Values for code for status of List. The system portion of the token shall not be populated. |
SHALL | designationType | token | This IHE extension on parameters defined as SearchParameter/List-DesignationType, of type token, specifies the designation type of the List. The value of the designation type element indicates the clinical purpose of the SubmissionSet or Folder. Note that servers that do not support this extended search parameter will ignore it, and thus return more results than expected. |
SHALL | sourceId | token | This IHE extension on parameters defined as SearchParameter/List-SourceId, of type token, specifies the source (author) value supplied in the List Resource. |
{
"resourceType" : "CapabilityStatement",
"id" : "IHE.MHD.DocumentConsumer",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement IHE.MHD.DocumentConsumer</b></p><a name=\"IHE.MHD.DocumentConsumer\"> </a><a name=\"hcIHE.MHD.DocumentConsumer\"> </a><a name=\"IHE.MHD.DocumentConsumer-en-US\"> </a><h2 id=\"title\">Document Consumer (client)</h2><ul><li>Implementation Guide Version: 4.2.3-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-07-15 19:14:36+0000 </li><li>Published by: IHE IT Infrastructure Technical Committee </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Recommend <a href=\"https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html\">ATNA</a>, encouraged <a href=\"https://profiles.ihe.net/ITI/IUA/index.html\">IHE-IUA</a> or SMART-on-FHIR</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>search-system</code>interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#DocumentReference1-1\">DocumentReference</a></td><td>https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Query.Minimal.DocumentReference</td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastupdated, author.given, author.family, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, related, security-label, setting, status, type</td><td/><td/><td/></tr><tr><td><a href=\"#List1-2\">List</a></td><td><a href=\"StructureDefinition-IHE.MHD.List.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.List</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastupdated, code, date, identifier, patient, patient.identifier, source.given, source.family, status, designationType, sourceId</td><td/><td/><td/></tr><tr><td><a href=\"#Binary1-3\">Binary</a></td><td>�</td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DocumentReference1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>DocumentReference</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/>https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Query.Minimal.DocumentReference</div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastupdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>author.given</td><td><code>string</code></td><td><div><p>These parameters, of type string, specify the name parts of the author person, which is associated with the DocumentReference Resource, or in Document Sharing nomenclature, the author of the Document Entry. See ITI TF-2x: Appendix Z.2 for use of the string data type.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>author.family</td><td><code>string</code></td><td><div><p>These parameters, of type string, specify the name parts of the author person, which is associated with the DocumentReference Resource, or in Document Sharing nomenclature, the author of the Document Entry. See ITI TF-2x: Appendix Z.2 for use of the string data type.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">category</a></td><td><code>token</code></td><td><div><p>Categorization of document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-DocumentReference-Creation.html\">creation</a></td><td><code>date</code></td><td><div><p>When this document was created</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">date</a></td><td><code>date</code></td><td><div><p>When this document reference was created</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">event</a></td><td><code>token</code></td><td><div><p>Main clinical acts documented</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">facility</a></td><td><code>token</code></td><td><div><p>Kind of facility where patient was seen</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">format</a></td><td><code>token</code></td><td><div><p>Format/content rules for the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>The identifier for this DocumentReference</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Who/what is the subject of the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient.identifier</td><td><code>token</code></td><td><div><p>An Identifier for Who/what is the subject of the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">period</a></td><td><code>date</code></td><td><div><p>Time of service that is being documented</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">related</a></td><td><code>reference</code></td><td><div><p>Related Resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">security-label</a></td><td><code>token</code></td><td><div><p>Document security-tags</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">setting</a></td><td><code>token</code></td><td><div><p>Additional details about where the content was created (e.g. clinical specialty)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">status</a></td><td><code>token</code></td><td><div><p>current | superseded | entered-in-error</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">type</a></td><td><code>reference</code></td><td><div><p>Kind of document (LOINC if possible)</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"List1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>List</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-IHE.MHD.List.html\">https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.List</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastupdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/list.html#search\">code</a></td><td><code>token</code></td><td><div><p>This parameter, of type token, specifies the code.coding value supplied in the List Resource. The value of the code element indicates the List of type SubmissionSet or Folder as indicated.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/list.html#search\">date</a></td><td><code>date</code></td><td><div><p>This parameter, of type date, specifies the time when the List was created.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/list.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>This parameter, of type token, specifies an identifier for this List. The search results represent the results of a search on List.masterIdentifier and List.identifier. See ITI TF-2x: Appendix Z.2 for additional constraints on the use of the token search parameter type.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/list.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>This parameter is of type Reference(Patient). The Document Consumer may get this reference through the use of the PDQm or PIXm Profiles, or by some other method. When the patient parameter is used, the Patient reference would need to be accessible to both the Document Consumer and the Document Responder.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient.identifier</td><td><code>token</code></td><td><div><p>An Identifier for Who/what is the subject of the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>source.given</td><td><code>string</code></td><td><div><p>These parameters, of type string, specify the name parts of the author person which is associated with the List. See ITI TF-2x: Appendix Z.2 for use of the string data type.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>source.family</td><td><code>string</code></td><td><div><p>These parameters, of type string, specify the name parts of the author person which is associated with the List. See ITI TF-2x: Appendix Z.2 for use of the string data type.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/list.html#search\">status</a></td><td><code>token</code></td><td><div><p>This parameter, of type token, specifies the status of the List. If included in the query, the Document Consumer shall populate the code portion of the token with one of the codes in the following Table 3.66.4.1.2.1-1: Values for code for status of List. The system portion of the token shall not be populated.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-List-DesignationType.html\">designationType</a></td><td><code>token</code></td><td><div><p>This IHE extension on parameters defined as SearchParameter/List-DesignationType, of type token, specifies the designation type of the List. The value of the designation type element indicates the clinical purpose of the SubmissionSet or Folder. Note that servers that do not support this extended search parameter will ignore it, and thus return more results than expected.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-List-SourceId.html\">sourceId</a></td><td><code>token</code></td><td><div><p>This IHE extension on parameters defined as SearchParameter/List-SourceId, of type token, specifies the source (author) value supplied in the List Resource.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Binary1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Binary</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/><p/></div></div></div></div>"
},
"url" : "https://profiles.ihe.net/ITI/MHD/CapabilityStatement/IHE.MHD.DocumentConsumer",
"version" : "4.2.3-current",
"name" : "IHE_MHD_DocumentConsumer",
"title" : "Document Consumer (client)",
"status" : "active",
"experimental" : false,
"date" : "2024-07-15T19:14:36+00:00",
"publisher" : "IHE IT Infrastructure Technical Committee",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
}
]
},
{
"telecom" : [
{
"system" : "email",
"value" : "iti@ihe.net"
}
]
},
{
"name" : "IHE IT Infrastructure Technical Committee",
"telecom" : [
{
"system" : "email",
"value" : "iti@ihe.net"
}
]
}
],
"description" : "IHE ITI Mobile access to Health Documents (MHD) - Document Consumer (client).",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+xml",
"application/fhir+json"
],
"rest" : [
{
"mode" : "client",
"security" : {
"description" : "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or SMART-on-FHIR"
},
"resource" : [
{
"type" : "DocumentReference",
"profile" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Query.Minimal.DocumentReference",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
},
{
"name" : "_lastupdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
},
{
"name" : "author.given",
"type" : "string",
"documentation" : "These parameters, of type string, specify the name parts of the author person, which is associated with the DocumentReference Resource, or in Document Sharing nomenclature, the author of the Document Entry. See ITI TF-2x: Appendix Z.2 for use of the string data type."
},
{
"name" : "author.family",
"type" : "string",
"documentation" : "These parameters, of type string, specify the name parts of the author person, which is associated with the DocumentReference Resource, or in Document Sharing nomenclature, the author of the Document Entry. See ITI TF-2x: Appendix Z.2 for use of the string data type."
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
"type" : "token",
"documentation" : "Categorization of document"
},
{
"name" : "creation",
"definition" : "https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation",
"type" : "date",
"documentation" : "When this document was created"
},
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-date",
"type" : "date",
"documentation" : "When this document reference was created"
},
{
"name" : "event",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
"type" : "token",
"documentation" : "Main clinical acts documented"
},
{
"name" : "facility",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
"type" : "token",
"documentation" : "Kind of facility where patient was seen"
},
{
"name" : "format",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
"type" : "token",
"documentation" : "Format/content rules for the document"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "The identifier for this DocumentReference"
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who/what is the subject of the document"
},
{
"name" : "patient.identifier",
"type" : "token",
"documentation" : "An Identifier for Who/what is the subject of the document"
},
{
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
"type" : "date",
"documentation" : "Time of service that is being documented"
},
{
"name" : "related",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-related",
"type" : "reference",
"documentation" : "Related Resource"
},
{
"name" : "security-label",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label",
"type" : "token",
"documentation" : "Document security-tags"
},
{
"name" : "setting",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
"type" : "token",
"documentation" : "Additional details about where the content was created (e.g. clinical specialty)"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"type" : "token",
"documentation" : "current | superseded | entered-in-error"
},
{
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Kind of document (LOINC if possible)"
}
]
},
{
"type" : "List",
"profile" : "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.List",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
},
{
"name" : "_lastupdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "When the resource version last changed"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "This parameter, of type token, specifies the code.coding value supplied in the List Resource. The value of the code element indicates the List of type SubmissionSet or Folder as indicated."
},
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "This parameter, of type date, specifies the time when the List was created."
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "This parameter, of type token, specifies an identifier for this List. The search results represent the results of a search on List.masterIdentifier and List.identifier. See ITI TF-2x: Appendix Z.2 for additional constraints on the use of the token search parameter type."
},
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "This parameter is of type Reference(Patient). The Document Consumer may get this reference through the use of the PDQm or PIXm Profiles, or by some other method. When the patient parameter is used, the Patient reference would need to be accessible to both the Document Consumer and the Document Responder."
},
{
"name" : "patient.identifier",
"type" : "token",
"documentation" : "An Identifier for Who/what is the subject of the document"
},
{
"name" : "source.given",
"type" : "string",
"documentation" : "These parameters, of type string, specify the name parts of the author person which is associated with the List. See ITI TF-2x: Appendix Z.2 for use of the string data type."
},
{
"name" : "source.family",
"type" : "string",
"documentation" : "These parameters, of type string, specify the name parts of the author person which is associated with the List. See ITI TF-2x: Appendix Z.2 for use of the string data type."
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/List-status",
"type" : "token",
"documentation" : "This parameter, of type token, specifies the status of the List. If included in the query, the Document Consumer shall populate the code portion of the token with one of the codes in the following Table 3.66.4.1.2.1-1: Values for code for status of List. The system portion of the token shall not be populated."
},
{
"name" : "designationType",
"definition" : "https://profiles.ihe.net/ITI/MHD/SearchParameter/List-DesignationType",
"type" : "token",
"documentation" : "This IHE extension on parameters defined as SearchParameter/List-DesignationType, of type token, specifies the designation type of the List. The value of the designation type element indicates the clinical purpose of the SubmissionSet or Folder. Note that servers that do not support this extended search parameter will ignore it, and thus return more results than expected."
},
{
"name" : "sourceId",
"definition" : "https://profiles.ihe.net/ITI/MHD/SearchParameter/List-SourceId",
"type" : "token",
"documentation" : "This IHE extension on parameters defined as SearchParameter/List-SourceId, of type token, specifies the source (author) value supplied in the List Resource."
}
]
},
{
"type" : "Binary",
"interaction" : [
{
"code" : "read"
}
]
}
],
"interaction" : [
{
"code" : "search-system"
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.